GetOrdersByOrderNumber (Method)

Description

Retrieves posted sales order linked to the shopper's current customer by the specified sales order number.Retrieves posted sales order linked to the shopper's current customer by the specified sales order number. Introduced in v2.21.

Request (GetOrdersByOrderNumberSoapIn)

The request body is of type GetOrdersByOrderNumber.

Request Body Parameters

Name	Description	Data Type
OrderNumber	The sales order number.	xml:string

Example

Javascript

MakeAJAXCall("Order.GetOrdersByOrderNumber", {
    OrderNumber: '000973'
}, console.log)

200 Response (GetOrdersByOrderNumberSoapOut)

The response body is of type GetOrdersByOrderNumberResponse.

Response Body Parameters

Name	Description	Data Type
GetOrdersByOrderNumberResult	A string value containing a JSON object. { "Data": [{ "SalesOrder": "001197", "Customer": "000000000000002", "CustomerName": "Bikes and Blades - North", "OrderStatus": "1", "Branch": "10", "OrderType": "", "Area": "N", "AlternateKey": "WEB98", "NextDetailLine": " 3", "DocumentType": "ORD", "Salesperson": "100", "Currency": "$", "CustomerPoNumber": "sdasdasd", "ShipViaCode": "", "ShippingInstrs": "FREE Ground Shipping", "SpecialInstrs": "", "OrderDate": "2019-10-15", "ReqShipDate": "2019-10-15", "SorQuery_Id": 0, "OrderStatusText": "Open Order" }], "Result": { "Success": true, "Message": "The request returned 1 order results.", "ElapsedTime": "41 ms" } }	xml:string

Name

Description

Data Type

GetOrdersByOrderNumberResult

A string value containing a JSON object.

{
    "Data": [{
        "SalesOrder": "001197",
        "Customer": "000000000000002",
        "CustomerName": "Bikes and Blades - North",
        "OrderStatus": "1",
        "Branch": "10",
        "OrderType": "",
        "Area": "N",
        "AlternateKey": "WEB98",
        "NextDetailLine": "    3",
        "DocumentType": "ORD",
        "Salesperson": "100",
        "Currency": "$",
        "CustomerPoNumber": "sdasdasd",
        "ShipViaCode": "",
        "ShippingInstrs": "FREE Ground Shipping",
        "SpecialInstrs": "",
        "OrderDate": "2019-10-15",
        "ReqShipDate": "2019-10-15",
        "SorQuery_Id": 0,
        "OrderStatusText": "Open Order"
    }],
    "Result": {
        "Success": true,
        "Message": "The request returned 1 order results.",
        "ElapsedTime": "41 ms"
    }
}

xml:string